home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / comms / other / amigancp_20 / docs / amigancp.doc next >
Text File  |  1999-05-17  |  60KB  |  1,903 lines
  1.  
  2.  
  3. AmigaNCP
  4. ********
  5.  
  6. Welcome to the AmigaNCP package, the AmigaOS implementation of
  7. Psion's NCP network protocol.
  8.  
  9. Copyright
  10. *********
  11.  
  12. The AmigaNCP package has been written by
  13.  
  14.      Oliver Wagner
  15.      Landsberge 5
  16.      D-45549 Sprockhövel
  17.      Germany
  18.      
  19.      email: owagner@vapor.com
  20.  
  21. The AmigaNCP driver library, the AmigaNCP File Server, the AmigaNCP
  22. File System, the AmigaNCP Documentation and all associated files are
  23. copyright (C) 1993-1999 Oliver Wagner, All Rights Reserved.
  24.  
  25.     Psion, the Psion Logo, Psion Series 3, 3-Link, Psion HC,
  26. Psion MC, SSD and Solid State Disk are registered Trademarks of
  27. Psion PLC.
  28.  
  29. The author wishes to thank the following people for their help during
  30. AmigaNCP development:
  31.  
  32. Frank "cyfm" Mariak
  33. Neil Bothwick
  34. Kenneth Jennings
  35. the members of the AmigaNCP Mailing List
  36.      For their help in implementing and debugging the EPOC32 protocol
  37.      part
  38.  
  39. David Wood of Psion Ltd.
  40.      Who provided the necessary information about the NCP protocol and
  41.      helped with beta testing the package
  42.  
  43. Jeremy "Jezar" Wakefield of Psion Ltd.
  44.      Who helped to track down several hidden and esoteric bugs.
  45.  
  46. Eric (ed@ramses.fdn.org)
  47.      For providing the original french catalog translation.
  48.  
  49. Phil Trickett (phil@dcs.king.ac.uk)
  50.      For the additional icon images.
  51.  
  52. Introduction
  53. ************
  54.  
  55. Overview
  56. ========
  57.  
  58. Psion's fine palmtop computer series, namely the S3 and S5, contain
  59. an even finer operating system, whose neat features cover a full
  60. fledged peer-to-peer networking software using a protocol called
  61. NCP.
  62.  
  63. Using NCP, you can link together two Psion computers or a Psion and a
  64. different, perhaps stationary machine and happily exchange data on your
  65. behalf.  NCP services include, but are not limited to, accessing files
  66. on the remote machines as if they were on yours, in both directions.
  67.  
  68. Linking your palmtop to your stationary machine is generally quite a
  69. good idea.  Doing so via the NCP protocol requires your stationary
  70. machine to have an implemention of this protocol.  There have only been
  71. implementations for MS-DOS clones (the MCLINK.EXE shell), for Apple
  72. MacIntosh and for Acorn Archimedes - until now.
  73.  
  74. AmigaNCP features a full NCP implementation including a remote file
  75. server to access Amiga files from your Psion and a file system to access
  76. Psion files from your Amiga.  The package also offers an API to allow
  77. custom applications to directly access network services at the NCP
  78. level.
  79.  
  80. Parts of AmigaNCP
  81. =================
  82.  
  83. AmigaNCP actually consists of several different programs.
  84.  
  85. The main part is the amigancp.library.  It contains the basic network
  86. services for exchanging data between two machines via a serial
  87. connection.  The protocol provides up to 8 data channels, which can be
  88. either passive (awaiting a connection from a client process) or active
  89. (attempting to connect to a server process).  One of the channels is
  90. reserved for the network supervisor application LINK.  The LINK
  91. functionality also has been integrated into amigancp.library.
  92.  
  93. Besides network I/O functions, the library also provides several
  94. utility functions to deal with Psion text format and the Intel byte
  95. ordering.
  96.  
  97. The AmigaNCP-FileSystem uses the amigancp.library to connect to
  98. the file server running on your Psion in order to provide access to
  99. Psion files from the AmigaDOS environment.  It provides a new AmigaDOS
  100. device named NCP: which offers access to all available Psion devices.
  101. The Psion devices will be mounted as subdirectories in the NCP:
  102. window.
  103.  
  104. The AmigaNCP-FileServer is an application built on top of
  105. amigancp.library.  It provides a means of accessing AmigaDOS
  106. files from the remote Psion computer via the REM:: file system.  This
  107. allows you to access Amiga files just as if they were local Psion
  108. files.  With the Psion S3a, it allows you to use the Backup option to
  109. backup vital data files on your Amiga's harddisk.
  110.  
  111. The AmigaNCP-Monitor monitors the activity of the NCP supervisor and
  112. gives detailed statistics about all channels.  This is an invaluable
  113. aid for debugging NCP applications.
  114.  
  115. The AmigaNCP-PrintServer allows you to print from your S3 or S5
  116. directly to a printer connected to the Amiga.
  117.  
  118. The S3Run program remotely launches programs or applications on your
  119. Psion.
  120.  
  121. Using AmigaNCP
  122. **************
  123.  
  124. Installation
  125. ============
  126.  
  127. For using AmigaNCP you'll need...
  128.  
  129.   1. any Amiga equipped with OS 2.04 or better and a free serial port
  130.  
  131.   2. the IBM-PC version of the 3-Link serial cable
  132.  
  133.   3. and a Psion S3, S3a, S3c or S5 (or any other model featuring
  134.      Remote Link)(1).
  135.  
  136.  
  137. To support Amiga systems without a hard disk, the AmigaNCP distribution
  138. has been organized to be ready-to-use.
  139.  
  140. Hard disk installation of AmigaNCP is best done using the provided
  141. Installer script.  The script will (by default) copy
  142. amigancp.library to LIBS:, put the language catalogs into
  143. LOCALE:Catalogs/ and create an AmigaNCP drawer on your work
  144. partition.  The drawer will contain the network services, documentation
  145. and the NCP tools.  There's an additional option for installing the
  146. amigancp.library developer material.
  147.  
  148. When installing the package for the first time, the installation
  149. procedure will ask you about the Psion model you're going to connect
  150. to.  The serial line speed will be set to the model's maximum (that is
  151. 9600 baud for the S3 or HC and 19200 baud for S3a or MC). You may
  152. change the serial parameters later on, though.
  153.  
  154. Configuring amigancp.library
  155. ============================
  156.  
  157. The default serial configuration is to use the serial.device, unit 0,
  158. at 9600 baud(2).
  159.  
  160. You can overwrite these default parameters by setting or changing the
  161. environment variable AmigaNCP.config.  The environment variable will
  162. be read by the amigancp.library each time a serial connection has to
  163. be established.
  164.  
  165. The parameter parsing is done just like in a shell command line; the
  166. template is D=DEVICE/K, U=UNIT/K/N, B=BAUD/K/N, NOREQ/S, SERIES5/S.
  167. All parameters are optional, those not given will retain their default
  168. values.
  169.  
  170. An example:  To make AmigaNCP use duart.device, unit 1 at 19200 baud
  171. you have to set ENV:AmigaNCP.config to
  172.  
  173.     DEVICE=duart.device UNIT=1 BAUD=19200
  174.  
  175. The installation script will create both ENV:AmigaNCP.config and
  176. ENVARC:AmigaNCP.config with either
  177.  
  178.     DEVICE=serial.device UNIT=0 BAUD=9600
  179.  
  180. or
  181.  
  182.     DEVICE=serial.device UNIT=0 BAUD=19200
  183.  
  184. depending on your choice of Psion model.  Please note, that you may
  185. actually use any baud rate supported by the serial port in question
  186. (and of course supported by the other side's serial interface as well).
  187.  
  188. If you set the NOREQ switch, the library will not display any error
  189. requesters.
  190.  
  191. Setting SERIES5 will enable the EPOC32 protocol support for the
  192. Series 5 models.
  193.  
  194. Note that you have to configure the remote site as well.  On the Psion
  195. S3 or S3a this consists of turning on NCP via the Remote Link menu of
  196. the system screen.  The baud rate must of course be set to the same
  197. value as used in ENV:NCP.config, or to 9600 if no configuration file
  198. exists.
  199.  
  200. Starting AmigaNCP
  201. =================
  202.  
  203. You don't start amigancp.library directly.  Instead you start one or
  204. more of the AmigaNCP applications, which in turn will open the library
  205. and try to establish their connections to the remote NCP site.
  206.  
  207. The library automatically terminates a connection about 10 seconds
  208. after the last application has closed its network channels.
  209.  
  210. Note that the underlying serial device is free to be used by any other
  211. application as long as no NCP connection is active and no connection
  212. attempt is made.
  213.  
  214. NCP Requesters
  215. ==============
  216.  
  217. The amigancp.library will put up error requesters if the network link
  218. breaks (and the NOREQ switch hasn't been set, see above).  The
  219. following table shows possible error condi